Save Utterance Params JSON Reference
| Declared in | Voiceflow.schema.json |
Overview
Specifies the parameters for saving an audio utterance.
Note: Unless stated otherwise, value of properties that are of type "string" can be updated at runtime by an application if their value is entered as a field name wrapped by "$[" and "]". If a property is of a type other than "string", then an additional property of type "string" with the same property name appended with the string "Runtime" is added to have its value entered as a field name wrapped by "$[" and "]". This allows the application to set the value of the field name at runtime to be the value of the original non-runtime property. Valid values of runtime fields override the values of non-runtime properties.
Tasks
-
saveUtterancepropertySpecifies whether to save the audio utterance sent to speech recognizer: Default:
"false". The value can be set at runtime using the"saveUtteranceRuntime"property.Parameter is optional.
-
saveUtteranceRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"saveUtterance"property. Example:"$[SaveUtterance]".Parameter is optional.
-
utteranceFileNamepropertyBase file name that will contain the recorded audio utterance. Default:
"BZAudioSaved". The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
utteranceFileLocationpropertyURL or location of folder where
"utteranceFileName"containing the recorded audio utterance will be located. The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
requestorIDpropertySpecifies an ID that can be used to distinguish recorded utterance files from others. User Defined.
"requestorID"is included in the name of the"utteranceFileName". Default:""(an empty string is inserted in the filename). The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
fileTypepropertySpecifies the audio file type. Default:
"wav". Only file type"wav"is currently supported. The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
includeTimeStamppropertySpecifies whether to include a time stamp as part of the recorded utterance audio file name. Default:
"false". The value can be set at runtime using the"includeTimeStampRuntime"property.Parameter is optional.
-
includeTimeStampRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"includeTimeStamp"property. Example:"$[IncludeTimeStamp]".Parameter is optional.
Properties
fileType
"fileType": string
Discussion
Specifies the audio file type. Default: "wav". Only file type "wav" is currently supported. The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
includeTimeStamp
"includeTimeStamp": boolean
Discussion
Specifies whether to include a time stamp as part of the recorded utterance audio file name. Default: "false". The value can be set at runtime using the "includeTimeStampRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
includeTimeStampRuntime
"includeTimeStampRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "includeTimeStamp" property. Example: "$[IncludeTimeStamp]".
Parameter is optional.
Declared In
Voiceflow.schema.json
requestorID
"requestorID": string
Discussion
Specifies an ID that can be used to distinguish recorded utterance files from others. User Defined. "requestorID" is included in the name of the "utteranceFileName". Default: "" (an empty string is inserted in the filename). The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
saveUtterance
"saveUtterance": boolean
Discussion
Specifies whether to save the audio utterance sent to speech recognizer: Default: "false". The value can be set at runtime using the "saveUtteranceRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
saveUtteranceRuntime
"saveUtteranceRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "saveUtterance" property. Example: "$[SaveUtterance]".
Parameter is optional.
Declared In
Voiceflow.schema.json
utteranceFileLocation
"utteranceFileLocation": string
Discussion
URL or location of folder where "utteranceFileName" containing the recorded audio utterance will be located. The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json